# JavaScript String localeCompare() Method

JavaScript String Reference

## Example

Compare two strings in the current locale:

var str1 = "ab";
var str2 = "cd";
var n = str1.localeCompare(str2);

The result of n will be:

-1 // str1 is sorted before str2
Try it yourself »

More "Try it Yourself" examples below.

## Definition and Usage

The localeCompare() method compares two strings in the current locale.

The locale is based on the language settings of the browser.

The localeCompare() method returns a number indicating whether the string comes before, after or is equal as the compareString in sort order.

## Browser Support

Method |  |  |  |  |
--- | --- | --- | --- | --- | ---
localeCompare() | Yes | Yes | Yes | Yes | Yes

## Syntax

string.localeCompare(compareString)

## Parameter Values

Parameter | Description
--- | ---
compareString | Required. The string to compare with

## Technical Details

Return Value:

A Number, indicating whether the reference string comes before, after or is the same as the compareString in sort order. Returns one of three values:

- -1 if the reference string is sorted before the compareString
- 0 if the two strings are equal
- 1 if the reference string is sorted after the compareString

JavaScript Version: | 1.2

## More Examples

## Example

Compare two strings in the current locale:

var str1 = "cd";
var str2 = "ab";
var n = str1.localeCompare(str2);

The result of n will be:

1 // str1 is sorted after str2
Try it yourself »

## Example

Compare two equal strings in the current locale:

var str1 = "ab";
var str2 = "ab";
var n = str1.localeCompare(str2);

The result of n will be:

0 // the two strings are equal
Try it yourself »

JavaScript String Reference

### WEB HOSTING

UK Reseller Hosting

### WEB BUILDING

FREE Website BUILDER Free HTML5 Templates

### W3SCHOOLS EXAMS

HTML, CSS, JavaScript, PHP, jQuery, XML, and ASP Certifications

### SHARE THIS PAGE

### Color Picker

### HTML/CSS

HTML Tutorial HTML5 Tutorial CSS Tutorial CSS3 Tutorial Bootstrap Tutorial

### JavaScript

JavaScript Tutorial jQuery Tutorial jQuery Mobile Tutorial AngularJS Tutorial AJAX Tutorial JSON Tutorial

### Graphics

Canvas Tutorial SVG Tutorial Google Maps Tutorial

### Server Side

SQL Tutorial PHP Tutorial ASP Tutorial ASP.NET Tutorial VBScript Tutorial AppML Tutorial

### Web

Web Building Web Statistics Web Certification

### XML

XML Tutorial DTD Tutorial Schema Tutorial XML DOM Tutorial XPath Tutorial XSLT Tutorial XQuery Tutorial XSL-FO Tutorial RSS Tutorial WSDL Tutorial

### HTML/CSS

HTML Tag Reference HTML Event Reference HTML Color Reference CSS 1,2,3 Reference Bootstrap Reference

### JavaScript

JavaScript Reference HTML DOM Reference jQuery Reference jQuery Mobile Reference Google Maps Reference

### Server Side

PHP Reference SQL Reference ASP Reference VBScript Reference Razor Reference ASP.NET Reference

### XML

XML DOM Reference XSLT Reference XSL-FO Reference XPath Reference XQuery Reference Schema Reference RSS Reference SVG Reference

### HTML Charsets

HTML Character Sets HTML ASCII HTML ANSI HTML Windows-1252 HTML ISO-8859-1 HTML Symbols HTML UTF-8

### HTML/CSS

HTML Examples CSS Examples

### Browser Scripting

JavaScript Examples HTML DOM Examples jQuery Examples jQuery Mobile Examples AngularJS Examples AJAX Examples

### Server Scripting

PHP Examples ASP Examples VBScript Examples Razor Examples .NET Examples

### XML Languages

XML Examples DTD Examples XML DOM Examples XSL Examples XSLT Examples XPath Examples XQuery Examples Schema Examples RSS Examples SVG Examples